Skip to content

chore(docs): update batch docs highlight & links #2320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 5, 2024

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

This PR makes a few slight corrections to both the docs page and README file for the Batch Processing utility, specifically:

  • correct misaligned syntax highlights in some of the code snippets
  • remove useless tooltip wrapping code snippet
  • update code snippet in README to use fetch instead of axios
  • fetch link to Lambda Layers to point to the correct docs section

Some of the actions described above were brought up here.

Related issues, RFCs

Issue number: #2319

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Apr 5, 2024
@dreamorosi dreamorosi requested a review from a team April 5, 2024 11:14
@dreamorosi dreamorosi requested a review from a team as a code owner April 5, 2024 11:14
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Apr 5, 2024
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Apr 5, 2024
Copy link

sonarqubecloud bot commented Apr 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@dreamorosi dreamorosi linked an issue Apr 5, 2024 that may be closed by this pull request
1 task
@dreamorosi dreamorosi merged commit 413af48 into main Apr 5, 2024
10 checks passed
@dreamorosi dreamorosi deleted the chore/docs/update_batch branch April 5, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/M PR between 30-99 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: review batch docs & readme
2 participants